<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2012 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import static com.google.common.collect.Maps.keyOrNull;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import com.google.common.annotations.Beta;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Iterator;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.NavigableMap;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.NavigableSet;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.NoSuchElementException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.SortedMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * A navigable map which forwards all its method calls to another navigable map. Subclasses should<a name="line.30"></a>
<span class="sourceLineNo">031</span> * override one or more methods to modify the behavior of the backing map as desired per the &lt;a<a name="line.31"></a>
<span class="sourceLineNo">032</span> * href="http://en.wikipedia.org/wiki/Decorator_pattern"&gt;decorator pattern&lt;/a&gt;.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;&lt;i&gt;Warning:&lt;/i&gt; The methods of {@code ForwardingNavigableMap} forward &lt;i&gt;indiscriminately&lt;/i&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * to the methods of the delegate. For example, overriding {@link #put} alone &lt;i&gt;will not&lt;/i&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * change the behavior of {@link #putAll}, which can lead to unexpected behavior. In this case, you<a name="line.36"></a>
<span class="sourceLineNo">037</span> * should override {@code putAll} as well, either providing your own implementation, or delegating<a name="line.37"></a>
<span class="sourceLineNo">038</span> * to the provided {@code standardPutAll} method.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;Each of the {@code standard} methods uses the map's comparator (or the natural ordering of<a name="line.40"></a>
<span class="sourceLineNo">041</span> * the elements, if there is no comparator) to test element equality. As a result, if the comparator<a name="line.41"></a>
<span class="sourceLineNo">042</span> * is not consistent with equals, some of the standard implementations may violate the {@code Map}<a name="line.42"></a>
<span class="sourceLineNo">043</span> * contract.<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;The {@code standard} methods and the collection views they return are not guaranteed to be<a name="line.45"></a>
<span class="sourceLineNo">046</span> * thread-safe, even when all of the methods that they depend on are thread-safe.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @author Louis Wasserman<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @since 12.0<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@Beta<a name="line.51"></a>
<span class="sourceLineNo">052</span>public abstract class ForwardingNavigableMap&lt;K, V&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span>    extends ForwardingSortedMap&lt;K, V&gt; implements NavigableMap&lt;K, V&gt; {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>  /** Constructor for use by subclasses. */<a name="line.55"></a>
<span class="sourceLineNo">056</span>  protected ForwardingNavigableMap() {}<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>  @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span>  protected abstract NavigableMap&lt;K, V&gt; delegate();<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>  @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span>  public Entry&lt;K, V&gt; lowerEntry(K key) {<a name="line.62"></a>
<span class="sourceLineNo">063</span>    return delegate().lowerEntry(key);<a name="line.63"></a>
<span class="sourceLineNo">064</span>  }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>  /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>   * A sensible definition of {@link #lowerEntry} in terms of the {@code lastEntry()} of<a name="line.67"></a>
<span class="sourceLineNo">068</span>   * {@link #headMap(Object, boolean)}. If you override {@code headMap}, you may wish to override<a name="line.68"></a>
<span class="sourceLineNo">069</span>   * {@code lowerEntry} to forward to this implementation.<a name="line.69"></a>
<span class="sourceLineNo">070</span>   */<a name="line.70"></a>
<span class="sourceLineNo">071</span>  protected Entry&lt;K, V&gt; standardLowerEntry(K key) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>    return headMap(key, false).lastEntry();<a name="line.72"></a>
<span class="sourceLineNo">073</span>  }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>  @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span>  public K lowerKey(K key) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>    return delegate().lowerKey(key);<a name="line.77"></a>
<span class="sourceLineNo">078</span>  }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>  /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>   * A sensible definition of {@link #lowerKey} in terms of {@code lowerEntry}. If you override<a name="line.81"></a>
<span class="sourceLineNo">082</span>   * {@link #lowerEntry}, you may wish to override {@code lowerKey} to forward to this<a name="line.82"></a>
<span class="sourceLineNo">083</span>   * implementation.<a name="line.83"></a>
<span class="sourceLineNo">084</span>   */<a name="line.84"></a>
<span class="sourceLineNo">085</span>  protected K standardLowerKey(K key) {<a name="line.85"></a>
<span class="sourceLineNo">086</span>    return keyOrNull(lowerEntry(key));<a name="line.86"></a>
<span class="sourceLineNo">087</span>  }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>  @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span>  public Entry&lt;K, V&gt; floorEntry(K key) {<a name="line.90"></a>
<span class="sourceLineNo">091</span>    return delegate().floorEntry(key);<a name="line.91"></a>
<span class="sourceLineNo">092</span>  }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>  /**<a name="line.94"></a>
<span class="sourceLineNo">095</span>   * A sensible definition of {@link #floorEntry} in terms of the {@code lastEntry()} of<a name="line.95"></a>
<span class="sourceLineNo">096</span>   * {@link #headMap(Object, boolean)}. If you override {@code headMap}, you may wish to override<a name="line.96"></a>
<span class="sourceLineNo">097</span>   * {@code floorEntry} to forward to this implementation.<a name="line.97"></a>
<span class="sourceLineNo">098</span>   */<a name="line.98"></a>
<span class="sourceLineNo">099</span>  protected Entry&lt;K, V&gt; standardFloorEntry(K key) {<a name="line.99"></a>
<span class="sourceLineNo">100</span>    return headMap(key, true).lastEntry();<a name="line.100"></a>
<span class="sourceLineNo">101</span>  }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>  @Override<a name="line.103"></a>
<span class="sourceLineNo">104</span>  public K floorKey(K key) {<a name="line.104"></a>
<span class="sourceLineNo">105</span>    return delegate().floorKey(key);<a name="line.105"></a>
<span class="sourceLineNo">106</span>  }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>  /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>   * A sensible definition of {@link #floorKey} in terms of {@code floorEntry}. If you override<a name="line.109"></a>
<span class="sourceLineNo">110</span>   * {@code floorEntry}, you may wish to override {@code floorKey} to forward to this<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * implementation.<a name="line.111"></a>
<span class="sourceLineNo">112</span>   */<a name="line.112"></a>
<span class="sourceLineNo">113</span>  protected K standardFloorKey(K key) {<a name="line.113"></a>
<span class="sourceLineNo">114</span>    return keyOrNull(floorEntry(key));<a name="line.114"></a>
<span class="sourceLineNo">115</span>  }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span>  @Override<a name="line.117"></a>
<span class="sourceLineNo">118</span>  public Entry&lt;K, V&gt; ceilingEntry(K key) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>    return delegate().ceilingEntry(key);<a name="line.119"></a>
<span class="sourceLineNo">120</span>  }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>  /**<a name="line.122"></a>
<span class="sourceLineNo">123</span>   * A sensible definition of {@link #ceilingEntry} in terms of the {@code firstEntry()} of<a name="line.123"></a>
<span class="sourceLineNo">124</span>   * {@link #tailMap(Object, boolean)}. If you override {@code tailMap}, you may wish to override<a name="line.124"></a>
<span class="sourceLineNo">125</span>   * {@code ceilingEntry} to forward to this implementation.<a name="line.125"></a>
<span class="sourceLineNo">126</span>   */<a name="line.126"></a>
<span class="sourceLineNo">127</span>  protected Entry&lt;K, V&gt; standardCeilingEntry(K key) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>    return tailMap(key, true).firstEntry();<a name="line.128"></a>
<span class="sourceLineNo">129</span>  }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span>  @Override<a name="line.131"></a>
<span class="sourceLineNo">132</span>  public K ceilingKey(K key) {<a name="line.132"></a>
<span class="sourceLineNo">133</span>    return delegate().ceilingKey(key);<a name="line.133"></a>
<span class="sourceLineNo">134</span>  }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span>  /**<a name="line.136"></a>
<span class="sourceLineNo">137</span>   * A sensible definition of {@link #ceilingKey} in terms of {@code ceilingEntry}. If you override<a name="line.137"></a>
<span class="sourceLineNo">138</span>   * {@code ceilingEntry}, you may wish to override {@code ceilingKey} to forward to this<a name="line.138"></a>
<span class="sourceLineNo">139</span>   * implementation.<a name="line.139"></a>
<span class="sourceLineNo">140</span>   */<a name="line.140"></a>
<span class="sourceLineNo">141</span>  protected K standardCeilingKey(K key) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>    return keyOrNull(ceilingEntry(key));<a name="line.142"></a>
<span class="sourceLineNo">143</span>  }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>  @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span>  public Entry&lt;K, V&gt; higherEntry(K key) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>    return delegate().higherEntry(key);<a name="line.147"></a>
<span class="sourceLineNo">148</span>  }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>  /**<a name="line.150"></a>
<span class="sourceLineNo">151</span>   * A sensible definition of {@link #higherEntry} in terms of the {@code firstEntry()} of<a name="line.151"></a>
<span class="sourceLineNo">152</span>   * {@link #tailMap(Object, boolean)}. If you override {@code tailMap}, you may wish to override<a name="line.152"></a>
<span class="sourceLineNo">153</span>   * {@code higherEntry} to forward to this implementation.<a name="line.153"></a>
<span class="sourceLineNo">154</span>   */<a name="line.154"></a>
<span class="sourceLineNo">155</span>  protected Entry&lt;K, V&gt; standardHigherEntry(K key) {<a name="line.155"></a>
<span class="sourceLineNo">156</span>    return tailMap(key, false).firstEntry();<a name="line.156"></a>
<span class="sourceLineNo">157</span>  }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>  @Override<a name="line.159"></a>
<span class="sourceLineNo">160</span>  public K higherKey(K key) {<a name="line.160"></a>
<span class="sourceLineNo">161</span>    return delegate().higherKey(key);<a name="line.161"></a>
<span class="sourceLineNo">162</span>  }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>  /**<a name="line.164"></a>
<span class="sourceLineNo">165</span>   * A sensible definition of {@link #higherKey} in terms of {@code higherEntry}. If you override<a name="line.165"></a>
<span class="sourceLineNo">166</span>   * {@code higherEntry}, you may wish to override {@code higherKey} to forward to this<a name="line.166"></a>
<span class="sourceLineNo">167</span>   * implementation.<a name="line.167"></a>
<span class="sourceLineNo">168</span>   */<a name="line.168"></a>
<span class="sourceLineNo">169</span>  protected K standardHigherKey(K key) {<a name="line.169"></a>
<span class="sourceLineNo">170</span>    return keyOrNull(higherEntry(key));<a name="line.170"></a>
<span class="sourceLineNo">171</span>  }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>  @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span>  public Entry&lt;K, V&gt; firstEntry() {<a name="line.174"></a>
<span class="sourceLineNo">175</span>    return delegate().firstEntry();<a name="line.175"></a>
<span class="sourceLineNo">176</span>  }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span>  /**<a name="line.178"></a>
<span class="sourceLineNo">179</span>   * A sensible definition of {@link #firstEntry} in terms of the {@code iterator()} of<a name="line.179"></a>
<span class="sourceLineNo">180</span>   * {@link #entrySet}. If you override {@code entrySet}, you may wish to override<a name="line.180"></a>
<span class="sourceLineNo">181</span>   * {@code firstEntry} to forward to this implementation.<a name="line.181"></a>
<span class="sourceLineNo">182</span>   */<a name="line.182"></a>
<span class="sourceLineNo">183</span>  protected Entry&lt;K, V&gt; standardFirstEntry() {<a name="line.183"></a>
<span class="sourceLineNo">184</span>    return Iterables.getFirst(entrySet(), null);<a name="line.184"></a>
<span class="sourceLineNo">185</span>  }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span>  /**<a name="line.187"></a>
<span class="sourceLineNo">188</span>   * A sensible definition of {@link #firstKey} in terms of {@code firstEntry}. If you override<a name="line.188"></a>
<span class="sourceLineNo">189</span>   * {@code firstEntry}, you may wish to override {@code firstKey} to forward to this<a name="line.189"></a>
<span class="sourceLineNo">190</span>   * implementation.<a name="line.190"></a>
<span class="sourceLineNo">191</span>   */<a name="line.191"></a>
<span class="sourceLineNo">192</span>  protected K standardFirstKey() {<a name="line.192"></a>
<span class="sourceLineNo">193</span>    Entry&lt;K, V&gt; entry = firstEntry();<a name="line.193"></a>
<span class="sourceLineNo">194</span>    if (entry == null) {<a name="line.194"></a>
<span class="sourceLineNo">195</span>      throw new NoSuchElementException();<a name="line.195"></a>
<span class="sourceLineNo">196</span>    } else {<a name="line.196"></a>
<span class="sourceLineNo">197</span>      return entry.getKey();<a name="line.197"></a>
<span class="sourceLineNo">198</span>    }<a name="line.198"></a>
<span class="sourceLineNo">199</span>  }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span>  @Override<a name="line.201"></a>
<span class="sourceLineNo">202</span>  public Entry&lt;K, V&gt; lastEntry() {<a name="line.202"></a>
<span class="sourceLineNo">203</span>    return delegate().lastEntry();<a name="line.203"></a>
<span class="sourceLineNo">204</span>  }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>  /**<a name="line.206"></a>
<span class="sourceLineNo">207</span>   * A sensible definition of {@link #lastEntry} in terms of the {@code iterator()} of the<a name="line.207"></a>
<span class="sourceLineNo">208</span>   * {@link #entrySet} of {@link #descendingMap}. If you override {@code descendingMap}, you may<a name="line.208"></a>
<span class="sourceLineNo">209</span>   * wish to override {@code lastEntry} to forward to this implementation.<a name="line.209"></a>
<span class="sourceLineNo">210</span>   */<a name="line.210"></a>
<span class="sourceLineNo">211</span>  protected Entry&lt;K, V&gt; standardLastEntry() {<a name="line.211"></a>
<span class="sourceLineNo">212</span>    return Iterables.getFirst(descendingMap().entrySet(), null);<a name="line.212"></a>
<span class="sourceLineNo">213</span>  }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span>  /**<a name="line.215"></a>
<span class="sourceLineNo">216</span>   * A sensible definition of {@link #lastKey} in terms of {@code lastEntry}. If you override<a name="line.216"></a>
<span class="sourceLineNo">217</span>   * {@code lastEntry}, you may wish to override {@code lastKey} to forward to this implementation.<a name="line.217"></a>
<span class="sourceLineNo">218</span>   */<a name="line.218"></a>
<span class="sourceLineNo">219</span>  protected K standardLastKey() {<a name="line.219"></a>
<span class="sourceLineNo">220</span>    Entry&lt;K, V&gt; entry = lastEntry();<a name="line.220"></a>
<span class="sourceLineNo">221</span>    if (entry == null) {<a name="line.221"></a>
<span class="sourceLineNo">222</span>      throw new NoSuchElementException();<a name="line.222"></a>
<span class="sourceLineNo">223</span>    } else {<a name="line.223"></a>
<span class="sourceLineNo">224</span>      return entry.getKey();<a name="line.224"></a>
<span class="sourceLineNo">225</span>    }<a name="line.225"></a>
<span class="sourceLineNo">226</span>  }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span>  @Override<a name="line.228"></a>
<span class="sourceLineNo">229</span>  public Entry&lt;K, V&gt; pollFirstEntry() {<a name="line.229"></a>
<span class="sourceLineNo">230</span>    return delegate().pollFirstEntry();<a name="line.230"></a>
<span class="sourceLineNo">231</span>  }<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span>  /**<a name="line.233"></a>
<span class="sourceLineNo">234</span>   * A sensible definition of {@link #pollFirstEntry} in terms of the {@code iterator} of<a name="line.234"></a>
<span class="sourceLineNo">235</span>   * {@code entrySet}. If you override {@code entrySet}, you may wish to override<a name="line.235"></a>
<span class="sourceLineNo">236</span>   * {@code pollFirstEntry} to forward to this implementation.<a name="line.236"></a>
<span class="sourceLineNo">237</span>   */<a name="line.237"></a>
<span class="sourceLineNo">238</span>  protected Entry&lt;K, V&gt; standardPollFirstEntry() {<a name="line.238"></a>
<span class="sourceLineNo">239</span>    return Iterators.pollNext(entrySet().iterator());<a name="line.239"></a>
<span class="sourceLineNo">240</span>  }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span>  @Override<a name="line.242"></a>
<span class="sourceLineNo">243</span>  public Entry&lt;K, V&gt; pollLastEntry() {<a name="line.243"></a>
<span class="sourceLineNo">244</span>    return delegate().pollLastEntry();<a name="line.244"></a>
<span class="sourceLineNo">245</span>  }<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span>  /**<a name="line.247"></a>
<span class="sourceLineNo">248</span>   * A sensible definition of {@link #pollFirstEntry} in terms of the {@code iterator} of the<a name="line.248"></a>
<span class="sourceLineNo">249</span>   * {@code entrySet} of {@code descendingMap}. If you override {@code descendingMap}, you may wish<a name="line.249"></a>
<span class="sourceLineNo">250</span>   * to override {@code pollFirstEntry} to forward to this implementation.<a name="line.250"></a>
<span class="sourceLineNo">251</span>   */<a name="line.251"></a>
<span class="sourceLineNo">252</span>  protected Entry&lt;K, V&gt; standardPollLastEntry() {<a name="line.252"></a>
<span class="sourceLineNo">253</span>    return Iterators.pollNext(descendingMap().entrySet().iterator());<a name="line.253"></a>
<span class="sourceLineNo">254</span>  }<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span>  @Override<a name="line.256"></a>
<span class="sourceLineNo">257</span>  public NavigableMap&lt;K, V&gt; descendingMap() {<a name="line.257"></a>
<span class="sourceLineNo">258</span>    return delegate().descendingMap();<a name="line.258"></a>
<span class="sourceLineNo">259</span>  }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span>  /**<a name="line.261"></a>
<span class="sourceLineNo">262</span>   * A sensible implementation of {@link NavigableMap#descendingMap} in terms of the methods of<a name="line.262"></a>
<span class="sourceLineNo">263</span>   * this {@code NavigableMap}. In many cases, you may wish to override<a name="line.263"></a>
<span class="sourceLineNo">264</span>   * {@link ForwardingNavigableMap#descendingMap} to forward to this implementation or a subclass<a name="line.264"></a>
<span class="sourceLineNo">265</span>   * thereof.<a name="line.265"></a>
<span class="sourceLineNo">266</span>   *<a name="line.266"></a>
<span class="sourceLineNo">267</span>   * &lt;p&gt;In particular, this map iterates over entries with repeated calls to<a name="line.267"></a>
<span class="sourceLineNo">268</span>   * {@link NavigableMap#lowerEntry}. If a more efficient means of iteration is available, you may<a name="line.268"></a>
<span class="sourceLineNo">269</span>   * wish to override the {@code entryIterator()} method of this class.<a name="line.269"></a>
<span class="sourceLineNo">270</span>   *<a name="line.270"></a>
<span class="sourceLineNo">271</span>   * @since 12.0<a name="line.271"></a>
<span class="sourceLineNo">272</span>   */<a name="line.272"></a>
<span class="sourceLineNo">273</span>  @Beta<a name="line.273"></a>
<span class="sourceLineNo">274</span>  protected class StandardDescendingMap extends Maps.DescendingMap&lt;K, V&gt; {<a name="line.274"></a>
<span class="sourceLineNo">275</span>    /** Constructor for use by subclasses. */<a name="line.275"></a>
<span class="sourceLineNo">276</span>    public StandardDescendingMap() {}<a name="line.276"></a>
<span class="sourceLineNo">277</span><a name="line.277"></a>
<span class="sourceLineNo">278</span>    @Override<a name="line.278"></a>
<span class="sourceLineNo">279</span>    NavigableMap&lt;K, V&gt; forward() {<a name="line.279"></a>
<span class="sourceLineNo">280</span>      return ForwardingNavigableMap.this;<a name="line.280"></a>
<span class="sourceLineNo">281</span>    }<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span>    @Override<a name="line.283"></a>
<span class="sourceLineNo">284</span>    protected Iterator&lt;Entry&lt;K, V&gt;&gt; entryIterator() {<a name="line.284"></a>
<span class="sourceLineNo">285</span>      return new Iterator&lt;Entry&lt;K, V&gt;&gt;() {<a name="line.285"></a>
<span class="sourceLineNo">286</span>        private Entry&lt;K, V&gt; toRemove = null;<a name="line.286"></a>
<span class="sourceLineNo">287</span>        private Entry&lt;K, V&gt; nextOrNull = forward().lastEntry();<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span>        @Override<a name="line.289"></a>
<span class="sourceLineNo">290</span>        public boolean hasNext() {<a name="line.290"></a>
<span class="sourceLineNo">291</span>          return nextOrNull != null;<a name="line.291"></a>
<span class="sourceLineNo">292</span>        }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span>        @Override<a name="line.294"></a>
<span class="sourceLineNo">295</span>        public java.util.Map.Entry&lt;K, V&gt; next() {<a name="line.295"></a>
<span class="sourceLineNo">296</span>          if (!hasNext()) {<a name="line.296"></a>
<span class="sourceLineNo">297</span>            throw new NoSuchElementException();<a name="line.297"></a>
<span class="sourceLineNo">298</span>          }<a name="line.298"></a>
<span class="sourceLineNo">299</span>          try {<a name="line.299"></a>
<span class="sourceLineNo">300</span>            return nextOrNull;<a name="line.300"></a>
<span class="sourceLineNo">301</span>          } finally {<a name="line.301"></a>
<span class="sourceLineNo">302</span>            toRemove = nextOrNull;<a name="line.302"></a>
<span class="sourceLineNo">303</span>            nextOrNull = forward().lowerEntry(nextOrNull.getKey());<a name="line.303"></a>
<span class="sourceLineNo">304</span>          }<a name="line.304"></a>
<span class="sourceLineNo">305</span>        }<a name="line.305"></a>
<span class="sourceLineNo">306</span><a name="line.306"></a>
<span class="sourceLineNo">307</span>        @Override<a name="line.307"></a>
<span class="sourceLineNo">308</span>        public void remove() {<a name="line.308"></a>
<span class="sourceLineNo">309</span>          Iterators.checkRemove(toRemove != null);<a name="line.309"></a>
<span class="sourceLineNo">310</span>          forward().remove(toRemove.getKey());<a name="line.310"></a>
<span class="sourceLineNo">311</span>          toRemove = null;<a name="line.311"></a>
<span class="sourceLineNo">312</span>        }<a name="line.312"></a>
<span class="sourceLineNo">313</span>      };<a name="line.313"></a>
<span class="sourceLineNo">314</span>    }<a name="line.314"></a>
<span class="sourceLineNo">315</span>  }<a name="line.315"></a>
<span class="sourceLineNo">316</span><a name="line.316"></a>
<span class="sourceLineNo">317</span>  @Override<a name="line.317"></a>
<span class="sourceLineNo">318</span>  public NavigableSet&lt;K&gt; navigableKeySet() {<a name="line.318"></a>
<span class="sourceLineNo">319</span>    return delegate().navigableKeySet();<a name="line.319"></a>
<span class="sourceLineNo">320</span>  }<a name="line.320"></a>
<span class="sourceLineNo">321</span><a name="line.321"></a>
<span class="sourceLineNo">322</span>  /**<a name="line.322"></a>
<span class="sourceLineNo">323</span>   * A sensible implementation of {@link NavigableMap#navigableKeySet} in terms of the methods of<a name="line.323"></a>
<span class="sourceLineNo">324</span>   * this {@code NavigableMap}. In many cases, you may wish to override<a name="line.324"></a>
<span class="sourceLineNo">325</span>   * {@link ForwardingNavigableMap#navigableKeySet} to forward to this implementation or a subclass<a name="line.325"></a>
<span class="sourceLineNo">326</span>   * thereof.<a name="line.326"></a>
<span class="sourceLineNo">327</span>   *<a name="line.327"></a>
<span class="sourceLineNo">328</span>   * @since 12.0<a name="line.328"></a>
<span class="sourceLineNo">329</span>   */<a name="line.329"></a>
<span class="sourceLineNo">330</span>  @Beta<a name="line.330"></a>
<span class="sourceLineNo">331</span>  protected class StandardNavigableKeySet extends Maps.NavigableKeySet&lt;K, V&gt; {<a name="line.331"></a>
<span class="sourceLineNo">332</span>    /** Constructor for use by subclasses. */<a name="line.332"></a>
<span class="sourceLineNo">333</span>    public StandardNavigableKeySet() {}<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span>    @Override<a name="line.335"></a>
<span class="sourceLineNo">336</span>    NavigableMap&lt;K, V&gt; map() {<a name="line.336"></a>
<span class="sourceLineNo">337</span>      return ForwardingNavigableMap.this;<a name="line.337"></a>
<span class="sourceLineNo">338</span>    }<a name="line.338"></a>
<span class="sourceLineNo">339</span>  }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span>  @Override<a name="line.341"></a>
<span class="sourceLineNo">342</span>  public NavigableSet&lt;K&gt; descendingKeySet() {<a name="line.342"></a>
<span class="sourceLineNo">343</span>    return delegate().descendingKeySet();<a name="line.343"></a>
<span class="sourceLineNo">344</span>  }<a name="line.344"></a>
<span class="sourceLineNo">345</span><a name="line.345"></a>
<span class="sourceLineNo">346</span>  /**<a name="line.346"></a>
<span class="sourceLineNo">347</span>   * A sensible definition of {@link #descendingKeySet} as the {@code navigableKeySet} of<a name="line.347"></a>
<span class="sourceLineNo">348</span>   * {@link #descendingMap}. (The {@link StandardDescendingMap} implementation implements<a name="line.348"></a>
<span class="sourceLineNo">349</span>   * {@code navigableKeySet} on its own, so as not to cause an infinite loop.) If you override<a name="line.349"></a>
<span class="sourceLineNo">350</span>   * {@code descendingMap}, you may wish to override {@code descendingKeySet} to forward to this<a name="line.350"></a>
<span class="sourceLineNo">351</span>   * implementation.<a name="line.351"></a>
<span class="sourceLineNo">352</span>   */<a name="line.352"></a>
<span class="sourceLineNo">353</span>  protected NavigableSet&lt;K&gt; standardDescendingKeySet() {<a name="line.353"></a>
<span class="sourceLineNo">354</span>    return descendingMap().navigableKeySet();<a name="line.354"></a>
<span class="sourceLineNo">355</span>  }<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span>  /**<a name="line.357"></a>
<span class="sourceLineNo">358</span>   * A sensible definition of {@link #subMap(Object, Object)} in terms of<a name="line.358"></a>
<span class="sourceLineNo">359</span>   * {@link #subMap(Object, boolean, Object, boolean)}. If you override<a name="line.359"></a>
<span class="sourceLineNo">360</span>   * {@code subMap(K, boolean, K, boolean)}, you may wish to override {@code subMap} to forward to<a name="line.360"></a>
<span class="sourceLineNo">361</span>   * this implementation.<a name="line.361"></a>
<span class="sourceLineNo">362</span>   */<a name="line.362"></a>
<span class="sourceLineNo">363</span>  @Override<a name="line.363"></a>
<span class="sourceLineNo">364</span>  protected SortedMap&lt;K, V&gt; standardSubMap(K fromKey, K toKey) {<a name="line.364"></a>
<span class="sourceLineNo">365</span>    return subMap(fromKey, true, toKey, false);<a name="line.365"></a>
<span class="sourceLineNo">366</span>  }<a name="line.366"></a>
<span class="sourceLineNo">367</span><a name="line.367"></a>
<span class="sourceLineNo">368</span>  @Override<a name="line.368"></a>
<span class="sourceLineNo">369</span>  public NavigableMap&lt;K, V&gt; subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive) {<a name="line.369"></a>
<span class="sourceLineNo">370</span>    return delegate().subMap(fromKey, fromInclusive, toKey, toInclusive);<a name="line.370"></a>
<span class="sourceLineNo">371</span>  }<a name="line.371"></a>
<span class="sourceLineNo">372</span><a name="line.372"></a>
<span class="sourceLineNo">373</span>  @Override<a name="line.373"></a>
<span class="sourceLineNo">374</span>  public NavigableMap&lt;K, V&gt; headMap(K toKey, boolean inclusive) {<a name="line.374"></a>
<span class="sourceLineNo">375</span>    return delegate().headMap(toKey, inclusive);<a name="line.375"></a>
<span class="sourceLineNo">376</span>  }<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span>  @Override<a name="line.378"></a>
<span class="sourceLineNo">379</span>  public NavigableMap&lt;K, V&gt; tailMap(K fromKey, boolean inclusive) {<a name="line.379"></a>
<span class="sourceLineNo">380</span>    return delegate().tailMap(fromKey, inclusive);<a name="line.380"></a>
<span class="sourceLineNo">381</span>  }<a name="line.381"></a>
<span class="sourceLineNo">382</span><a name="line.382"></a>
<span class="sourceLineNo">383</span>  /**<a name="line.383"></a>
<span class="sourceLineNo">384</span>   * A sensible definition of {@link #headMap(Object)} in terms of<a name="line.384"></a>
<span class="sourceLineNo">385</span>   * {@link #headMap(Object, boolean)}. If you override {@code headMap(K, boolean)}, you may wish<a name="line.385"></a>
<span class="sourceLineNo">386</span>   * to override {@code headMap} to forward to this implementation.<a name="line.386"></a>
<span class="sourceLineNo">387</span>   */<a name="line.387"></a>
<span class="sourceLineNo">388</span>  protected SortedMap&lt;K, V&gt; standardHeadMap(K toKey) {<a name="line.388"></a>
<span class="sourceLineNo">389</span>    return headMap(toKey, false);<a name="line.389"></a>
<span class="sourceLineNo">390</span>  }<a name="line.390"></a>
<span class="sourceLineNo">391</span><a name="line.391"></a>
<span class="sourceLineNo">392</span>  /**<a name="line.392"></a>
<span class="sourceLineNo">393</span>   * A sensible definition of {@link #tailMap(Object)} in terms of<a name="line.393"></a>
<span class="sourceLineNo">394</span>   * {@link #tailMap(Object, boolean)}. If you override {@code tailMap(K, boolean)}, you may wish<a name="line.394"></a>
<span class="sourceLineNo">395</span>   * to override {@code tailMap} to forward to this implementation.<a name="line.395"></a>
<span class="sourceLineNo">396</span>   */<a name="line.396"></a>
<span class="sourceLineNo">397</span>  protected SortedMap&lt;K, V&gt; standardTailMap(K fromKey) {<a name="line.397"></a>
<span class="sourceLineNo">398</span>    return tailMap(fromKey, true);<a name="line.398"></a>
<span class="sourceLineNo">399</span>  }<a name="line.399"></a>
<span class="sourceLineNo">400</span>}<a name="line.400"></a>




























































</pre>
</div>
</body>
</html>
